home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / gdb-4.5 / ds3100.md / bfd / doc / bfd.info-3 < prev    next >
Encoding:
Text File  |  1992-07-01  |  20.6 KB  |  546 lines

  1. Info file bfd.info, produced by Makeinfo, -*- Text -*- from input
  2. file ./bfd.texinfo.
  3.  
  4. START-INFO-DIR-ENTRY
  5. * Bfd: (bfd).            The Binary File Descriptor library.
  6. END-INFO-DIR-ENTRY
  7.  
  8. This file documents the BFD library.
  9.  
  10. Copyright (C) 1991 Free Software Foundation, Inc.
  11.  
  12. Permission is granted to make and distribute verbatim copies of this
  13. manual provided the copyright notice and this permission notice are
  14. preserved on all copies.
  15.  
  16. Permission is granted to copy and distribute modified versions of this
  17. manual under the conditions for verbatim copying, subject to the
  18. terms of the GNU General Public License, which includes the provision
  19. that the entire resulting derived work is distributed under the terms
  20. of a permission notice identical to this one.
  21.  
  22. Permission is granted to copy and distribute translations of this
  23. manual into another language, under the above conditions for modified
  24. versions.
  25.  
  26.  
  27. 
  28. File: bfd.info,  Node: aout,  Next: coff,  Prev: What to Put Where,  Up: BFD back end
  29.  
  30. a.out backends
  31. ==============
  32.  
  33.  
  34. *Description*
  35.  BFD supports a number of different flavours of a.out format, though the
  36. major differences are only the sizes of the structures on disk, and
  37. the shape of the relocation information.  The support is split into a
  38. basic support file `aoutx.h' and other files which derive functions
  39. from the base. One derivation file is `aoutf1.h' (for a.out flavour
  40. 1), and adds to the basic a.out functions support for sun3, sun4, 386
  41. and 29k a.out files, to create a target jump vector for a specific
  42. target.  This information is further split out into more specific
  43. files for each machine, including `sunos.c' for sun3 and sun4,
  44. `newsos3.c' for the Sony NEWS, and `demo64.c' for a demonstration of
  45. a 64 bit a.out format.  The base file `aoutx.h' defines general
  46. mechanisms for reading and writing records to and from disk, and
  47. various other methods which BFD requires. It is included by
  48. `aout32.c' and `aout64.c' to form the names
  49. aout_32_swap_exec_header_in, aout_64_swap_exec_header_in, etc.  As an
  50. example, this is what goes on to make the back end for a sun4, from
  51. aout32.c
  52.  
  53.     #define ARCH_SIZE 32
  54.     #include "aoutx.h"
  55.  
  56. Which exports names:
  57.  
  58.     ...
  59.     aout_32_canonicalize_reloc
  60.     aout_32_find_nearest_line
  61.     aout_32_get_lineno
  62.     aout_32_get_reloc_upper_bound
  63.     ...
  64.  
  65. from sunos.c
  66.  
  67.     #define ARCH 32
  68.     #define TARGET_NAME "a.out-sunos-big"
  69.     #define VECNAME    sunos_big_vec
  70.     #include "aoutf1.h"
  71.  
  72. requires all the names from aout32.c, and produces the jump vector
  73.  
  74.     sunos_big_vec
  75.  
  76. The file host-aout.c is a special case.  It is for a large set of hosts
  77. that use "more or less standard" a.out files, and for which
  78. cross-debugging is not interesting.  It uses the standard 32-bit
  79. a.out support routines, but determines the file offsets and addresses
  80. of the text, data, and BSS sections, the machine architecture and
  81. machine type, and the entry point address, in a host-dependent
  82. manner.  Once these values have been determined, generic code is used
  83. to handle the  object file.  When porting it to run on a new system,
  84. you must supply:
  85.  
  86.         HOST_PAGE_SIZE
  87.         HOST_SEGMENT_SIZE
  88.         HOST_MACHINE_ARCH       (optional)
  89.         HOST_MACHINE_MACHINE    (optional)
  90.         HOST_TEXT_START_ADDR
  91.         HOST_STACK_END_ADDR
  92.  
  93. in the file `../include/sys/h-XXX.h' (for your host).  These values,
  94. plus the structures and macros defined in `a.out.h' on your host
  95. system, will produce a BFD target that will access ordinary a.out
  96. files on your host. To configure a new machine to use `host-aout.c',
  97. specify:
  98.  
  99.     TDEFAULTS = -DDEFAULT_VECTOR=host_aout_big_vec
  100.     TDEPFILES= host-aout.o trad-core.o
  101.  
  102. in the `config/mt-XXX' file, and modify configure.in to use the
  103. `mt-XXX' file (by setting "`bfd_target=XXX'") when your configuration
  104. is selected.
  105.  
  106. relocations
  107. -----------
  108.  
  109.  
  110. *Description*
  111.  The file `aoutx.h' caters for both the *standard* and *extended* forms of
  112. a.out relocation records.  The standard records are characterised by
  113. containing only an address, a symbol index and a type field. The
  114. extended records (used on 29ks and sparcs) also have a full integer
  115. for an addend.
  116.  
  117. Internal Entry Points
  118. ---------------------
  119.  
  120.  
  121. *Description*
  122.  `aoutx.h' exports several routines for accessing the contents of an a.out
  123. file, which are gathered and exported in turn by various format
  124. specific files (eg sunos.c).
  125.  
  126. `aout_<size>_swap_exec_header_in'
  127. .................................
  128.  
  129. *Description*
  130.  Swaps the information in an executable header taken from a raw byte
  131. stream memory image, into the internal exec_header structure.
  132.  
  133. void aout_<size>_swap_exec_header_in, (bfd *abfd, struct external_exec
  134. *raw_bytes, struct internal_exec *execp);
  135.  
  136. `aout_<size>_swap_exec_header_out'
  137. ..................................
  138.  
  139. *Description*
  140.  Swaps the information in an internal exec header structure into the
  141. supplied buffer ready for writing to disk.
  142.  
  143. void aout_<size>_swap_exec_header_out (bfd *abfd, struct internal_exec
  144. *execp, struct external_exec *raw_bytes);
  145.  
  146. `aout_<size>_some_aout_object_p'
  147. ................................
  148.  
  149. *Description*
  150.  Some A.OUT variant thinks that the file whose format we're checking is an
  151. a.out file.  Do some more checking, and set up for access if it
  152. really is.  Call back to the calling environments "finish up"
  153. function just before returning, to handle any last-minute setup.
  154.  
  155. bfd_target *aout_<size>_some_aout_object_p (bfd *abfd, bfd_target
  156. *(*callback_to_real_object_p)());
  157.  
  158. `aout_<size>_mkobject'
  159. ......................
  160.  
  161. *Description*
  162.  This routine initializes a BFD for use with a.out files.
  163.  
  164. boolean aout_<size>_mkobject, (bfd *);
  165.  
  166. `aout_<size>_machine_type'
  167. ..........................
  168.  
  169. *Description*
  170.  Keep track of machine architecture and machine type for a.out's. Return
  171. the machine_type for a particular arch&machine, or M_UNKNOWN if that
  172. exact arch&machine can't be represented in a.out format.  If the
  173. architecture is understood, machine type 0 (default) should always be
  174. understood.
  175.  
  176. enum machine_type  aout_<size>_machine_type (enum bfd_architecture
  177. arch, unsigned long machine));
  178.  
  179. `aout_<size>_set_arch_mach'
  180. ...........................
  181.  
  182. *Description*
  183.  Sets the architecture and the machine of the BFD to those values
  184. supplied. Verifies that the format can support the architecture
  185. required.
  186.  
  187. boolean aout_<size>_set_arch_mach, (bfd *, enum bfd_architecture,
  188. unsigned long machine));
  189.  
  190. `aout_<size>new_section_hook'
  191. .............................
  192.  
  193. *Description*
  194.  Called by the BFD in response to a `bfd_make_section' request.
  195.  
  196. boolean aout_<size>_new_section_hook, (bfd *abfd, asection *newsect));
  197.  
  198.  
  199. 
  200. File: bfd.info,  Node: coff,  Prev: aout,  Up: BFD back end
  201.  
  202. coff backends
  203. =============
  204.  
  205. BFD supports a number of different flavours of coff format.  The major
  206. difference between formats are the sizes and alignments of fields in
  207. structures on disk, and the occasional extra field.   Coff in all its
  208. varieties is implimented with a few common files and a number of
  209. implementation specific files. For example, The 88k bcs coff format
  210. is implemented in the file `coff-m88k.c'. This file `#include's
  211. `coff-m88k.h' which defines the external structure of the coff format
  212. for the 88k, and `internalcoff.h' which defines the internal
  213. structure. `coff-m88k.c' also defines pthe relocations used by the
  214. 88k format *Note Relocations::. Then the major portion of coff code
  215. is included (`coffcode.h') which defines the methods used to act upon
  216. the types defined in `coff-m88k.h' and `internalcoff.h'.  The Intel
  217. i960 processor version of coff is implemented in `coff-i960.c'. This
  218. file has the same structure as `coff-m88k.c', except that it includes
  219. `coff-i960.h' rather than `coff-m88k.h'.
  220.  
  221. Porting To A New Version of Coff
  222. --------------------------------
  223.  
  224. The recommended method is to select from the existing implimentations
  225. the version of coff which is most like the one you want to use, for
  226. our purposes, we'll say that i386 coff is the one you select, and
  227. that your coff flavour is called foo.  Copy the `i386coff.c' to
  228. `foocoff.c', copy `../include/i386coff.h' to `../include/foocoff.h'
  229. and add the lines to `targets.c' and `Makefile.in' so that your new
  230. back end is used. Alter the shapes of the structures in
  231. `../include/foocoff.h' so that they match what you need. You will
  232. probably also have to add `#ifdef's to the code in `internalcoff.h'
  233. and `coffcode.h' if your version of coff is too wild.  You can verify
  234. that your new BFD backend works quite simply by building `objdump'
  235. from the `binutils' directory, and making sure that its version of
  236. what's going on at your host systems idea (assuming it has the pretty
  237. standard coff dump utility (usually called `att-dump' or just
  238. `dump')) are the same.  Then clean up your code, and send what you've
  239. done to Cygnus. Then your stuff will be in the next release, and you
  240. won't have to keep integrating it.
  241.  
  242. How The Coff Backend Works
  243. --------------------------
  244.  
  245.  
  246. Bit Twiddling
  247. ..............
  248.  
  249. Each flavour of coff supported in BFD has its own header file descibing
  250. the external layout of the structures. There is also an internal
  251. description of the coff layout (in `internalcoff.h') file (`'). A
  252. major function of the coff backend is swapping the bytes and
  253. twiddling the bits to translate the external form of the structures
  254. into the normal internal form. This is all performed in the
  255. `bfd_swap'_thing_direction routines. Some elements are different
  256. sizes between different versions of coff, it is the duty of the coff
  257. version specific include file to override the definitions of various
  258. packing routines in `coffcode.h'. Eg the size of line number entry in
  259. coff is sometimes 16 bits, and sometimes 32 bits. `#define'ing
  260. `PUT_LNSZ_LNNO' and `GET_LNSZ_LNNO' will select the correct one. No
  261. doubt, some day someone will find a version of coff which has a
  262. varying field size not catered for at the moment. To port BFD, that
  263. person will have to add more `#defines'.   Three of the bit twiddling
  264. routines are exported to `gdb'; `coff_swap_aux_in',
  265. `coff_swap_sym_in' and `coff_swap_linno_in'. `GDB' reads the symbol
  266. table on its own, but uses BFD to fix things up.  More of the bit
  267. twiddlers are exported for `gas'; `coff_swap_aux_out',
  268. `coff_swap_sym_out', `coff_swap_lineno_out', `coff_swap_reloc_out',
  269. `coff_swap_filehdr_out', `coff_swap_aouthdr_out',
  270. `coff_swap_scnhdr_out'. `Gas' currently keeps track of all the symbol
  271. table and reloc drudgery itself, thereby saving the internal BFD
  272. overhead, but uses BFD to swap things on the way out, making cross
  273. ports much safer.  This also allows BFD (and thus the linker) to use
  274. the same header files as `gas', which makes one avenue to disaster
  275. disappear.
  276.  
  277. Symbol Reading
  278. ..............
  279.  
  280. The simple canonical form for symbols used by BFD is not rich enough to
  281. keep all the information available in a coff symbol table. The back
  282. end gets around this by keeping the original symbol table around,
  283. "behind the scenes".  When a symbol table is requested (through a
  284. call to `bfd_canonicalize_symtab', a request gets through to
  285. `get_normalized_symtab'. This reads the symbol table from the coff
  286. file and swaps all the structures inside into the internal form. It
  287. also fixes up all the pointers in the table (represented in the file
  288. by offsets from the first symbol in the table) into physical pointers
  289. to elements in the new internal table. This involves some work since
  290. the meanings of fields changes depending upon context; a field that
  291. is a pointer to another structure in the symbol table at one moment
  292. may be the size in bytes of a structure in the next.  Another pass is
  293. made over the table. All symbols which mark file names (`C_FILE'
  294. symbols) are modified so that the internal string points to the value
  295. in the auxent (the real filename) rather than the normal text
  296. associated with the symbol (`".file"').  At this time the symbol
  297. names are moved around. Coff stores all symbols less than nine
  298. characters long physically within the symbol table, longer strings
  299. are kept at the end of the file in the string     table. This
  300. pass moves all strings into memory, and replaces them with pointers
  301. to the strings.  The symbol table is massaged once again, this time
  302. to create the canonical table used by the BFD application. Each
  303. symbol is inspected in turn, and a decision made (using the `sclass'
  304. field) about the various flags to set in the `asymbol' *Note
  305. Symbols::. The generated canonical table shares strings with the
  306. hidden internal symbol table.  Any linenumbers are read from the coff
  307. file too, and attached to the symbols which own the functions the
  308. linenumbers belong to.
  309.  
  310. Symbol Writing
  311. ..............
  312.  
  313. Writing a symbol to a coff file which didn't come from a coff file will
  314. lose any debugging information. The `asymbol' structure remembers the
  315. BFD from which was born, and on output the back end makes sure that
  316. the same destination target as source target is present.  When the
  317. symbols have come from a coff file then all the debugging information
  318. is preserved.  Symbol tables are provided for writing to the back end
  319. in a vector of pointers to pointers. This allows applications like
  320. the linker to accumulate and output large symbol tables without
  321. having to do too much byte copying.  This function runs through the
  322. provided symbol table and patches each symbol marked as a file place
  323. holder (`C_FILE') to point to the next file place holder in the list.
  324. It also marks each `offset' field in the list with the offset from
  325. the first symbol of the current symbol.  Another function of this
  326. procedure is to turn the canonical value form of BFD into the form
  327. used by coff. Internally, BFD expects symbol values to be offsets
  328. from a section base; so a symbol physically at 0x120, but in a
  329. section starting at 0x100, would have the value 0x20. Coff expects
  330. symbols to contain their final value, so symbols have their values
  331. changed at this point to reflect their sum with their owning section.
  332. Note that this transformation uses the `output_section' field of the
  333. `asymbol''s `asection' *Note Sections::.
  334.  
  335. * This routine runs though the provided symbol table and uses the
  336. offsets generated by the previous pass and the pointers generated
  337. when the symbol table was read in to create the structured hierachy
  338. required by coff. It changes each pointer to a symbol to an index
  339. into the symbol table of the symbol being referenced.
  340.  
  341. * This routine runs through the symbol table and patches up the symbols
  342. from their internal form into the coff way, calls the bit twiddlers
  343. and writes out the tabel to the file.
  344.  
  345.  
  346. `coff_symbol_type'
  347. ...................
  348.  
  349. *Description*
  350.  The hidden information for an asymbol is described in a coff_ptr_struct,
  351. which is typedefed to a combined_entry_type
  352.  
  353. .
  354.  
  355. typedef struct coff_ptr_struct 
  356. {
  357.  
  358.            /* Remembers the offset from the first symbol in the file for
  359.           this symbol. Generated by coff_renumber_symbols. */
  360. unsigned int offset;
  361.  
  362.            /* Should the tag field of this symbol be renumbered.
  363.           Created by coff_pointerize_aux. */
  364. char fix_tag;
  365.  
  366.            /* Should the endidx field of this symbol be renumbered.
  367.           Created by coff_pointerize_aux. */
  368. char fix_end;
  369.  
  370.            /* The container for the symbol structure as read and translated
  371.            from the file. */
  372.  
  373. union {
  374.    union internal_auxent auxent;
  375.    struct internal_syment syment;
  376.  } u;
  377. } combined_entry_type;
  378.  
  379.  
  380.     /* Each canonical asymbol really looks like this: */
  381.  
  382. typedef struct coff_symbol_struct
  383. {
  384.        /* The actual symbol which the rest of BFD works with */
  385. asymbol symbol;
  386.  
  387.        /* A pointer to the hidden information for this symbol */
  388. combined_entry_type *native;
  389.  
  390.        /* A pointer to the linenumber information for this symbol */
  391. struct lineno_cache_entry *lineno;
  392.  
  393.        /* Have the line numbers been relocated yet ? */
  394. boolean done_lineno;
  395. } coff_symbol_type;
  396.  
  397. Writing Relocations
  398. ...................
  399.  
  400. To write relocations, all the back end does is step though the
  401. canonical relocation table, and create an `internal_reloc'. The
  402. symbol index to use is removed from the `offset' field in the symbol
  403. table supplied, the address comes directly from the sum of the
  404. section base address and the relocation offset and the type is dug
  405. directly from the howto field.  Then the `internal_reloc' is swapped
  406. into the shape of an `external_reloc' and written out to disk.
  407.  
  408. Reading Linenumbers
  409. ...................
  410.  
  411. Creating the linenumber table is done by reading in the entire coff
  412. linenumber table, and creating another table for internal use.  A
  413. coff line number table is structured so that each function is marked
  414. as having a line number of 0. Each line within the function is an
  415. offset from the first line in the function. The base of the line
  416. number information for the table is stored in the symbol associated
  417. with the function.  The information is copied from the external to
  418. the internal table, and each symbol which marks a function is marked
  419. by pointing its...  How does this work ?
  420.  
  421. Reading Relocations
  422. ...................
  423.  
  424. Coff relocations are easily transformed into the internal BFD form
  425. (`arelent').  Reading a coff relocation table is done in the
  426. following stages:
  427.  
  428. * external to the internal form.
  429.  
  430. * turned intoa pointer into the canonical symbol table. Note that this
  431. table is the same as the one returned by a call to
  432. `bfd_canonicalize_symtab'. The back end will call the routine and
  433. save the result if a canonicalization hasn't been done.
  434.  
  435. * structure, in a back end specific way. For instance, the 386 and 960
  436. use the `r_type' to directly produce an index into a howto table
  437. vector; the 88k subtracts a number from the `r_type' field and
  438. creates an addend field.
  439.  
  440.  
  441.  
  442. 
  443. File: bfd.info,  Node: Index,  Prev: BFD back end,  Up: Top
  444.  
  445. Index
  446. *****
  447.  
  448. * Menu:
  449.  
  450. * BFD: Overview.
  451. * BFD canonical format: Mechanism.
  452. * BFD_CACHE_MAX_OPEN macro: File Caching.
  453. * The bfd_get_mtime function: BFD front end.
  454. * aout_<size>_machine_type: aout.
  455. * aout_<size>_mkobject: aout.
  456. * aout_<size>_set_arch_mach: aout.
  457. * aout_<size>_some_aout_object_p: aout.
  458. * aout_<size>_swap_exec_header_in: aout.
  459. * aout_<size>_swap_exec_header_out: aout.
  460. * aout_<size>new_section_hook: aout.
  461. * bfd_alloc_by_size_t: Opening and Closing.
  462. * bfd_arch_bits_per_address: Architectures.
  463. * bfd_arch_bits_per_byte: Architectures.
  464. * bfd_arch_get_compatible: Architectures.
  465. * bfd_arch_init: Architectures.
  466. * bfd_arch_linkin: Architectures.
  467. * bfd_cache_close: File Caching.
  468. * bfd_cache_init: File Caching.
  469. * bfd_cache_lookup: File Caching.
  470. * bfd_cache_lookup_worker: File Caching.
  471. * bfd_canonicalize_reloc: BFD front end.
  472. * bfd_canonicalize_symtab: symbol handling functions.
  473. * bfd_check_format: Formats.
  474. * bfd_check_init: Initialization.
  475. * bfd_close: Opening and Closing.
  476. * bfd_close_all_done: Opening and Closing.
  477. * bfd_constructor_entry: Constructors.
  478. * bfd_core_file_failing_command: Core Files.
  479. * bfd_core_file_failing_signal: Core Files.
  480. * bfd_create: Opening and Closing.
  481. * bfd_decode_symclass: symbol handling functions.
  482. * bfd_default_arch_struct: Architectures.
  483. * bfd_default_compatible: Architectures.
  484. * bfd_default_reloc_type_lookup: howto manager.
  485. * bfd_default_scan: Architectures.
  486. * bfd_default_set_arch_mach: Architectures.
  487. * bfd_fdopenr: Opening and Closing.
  488. * bfd_find_target: bfd_target.
  489. * bfd_format_string: Formats.
  490. * bfd_generic_get_relocated_section_contents: howto manager.
  491. * bfd_generic_relax_section: howto manager.
  492. * bfd_get_arch: Architectures.
  493. * bfd_get_arch_info: Architectures.
  494. * bfd_get_elt_at_index: Archives.
  495. * bfd_get_mach: Architectures.
  496. * bfd_get_next_mapent: Archives.
  497. * bfd_get_reloc_upper_bound: BFD front end.
  498. * bfd_get_section_by_name: section prototypes.
  499. * bfd_get_section_contents: section prototypes.
  500. * bfd_get_size: Internal.
  501. * bfd_h_get_size: Internal.
  502. * bfd_h_put_size: Internal.
  503. * bfd_init: Initialization.
  504. * bfd_last_cache: File Caching.
  505. * bfd_log2: Internal.
  506. * bfd_lookup_arch: Architectures.
  507. * bfd_make_empty_symbol: symbol handling functions.
  508. * bfd_make_section: section prototypes.
  509. * bfd_make_section_old_way: section prototypes.
  510. * bfd_map_over_sections: section prototypes.
  511. * bfd_open_file: File Caching.
  512. * bfd_openr: Opening and Closing.
  513. * bfd_openr_next_archived_file: Archives.
  514. * bfd_openw: Opening and Closing.
  515. * bfd_perform_relocation: typedef arelent.
  516. * bfd_print_symbol_vandf: symbol handling functions.
  517. * bfd_printable_arch_mach: Architectures.
  518. * bfd_printable_name: Architectures.
  519. * bfd_put_size: Internal.
  520. * bfd_reloc_code_type: howto manager.
  521. * bfd_scan_arch: Architectures.
  522. * bfd_set_arch_info: Architectures.
  523. * bfd_set_archive_head: Archives.
  524. * bfd_set_file_flags: BFD front end.
  525. * bfd_set_format: Formats.
  526. * bfd_set_reloc: BFD front end.
  527. * bfd_set_section_contents: section prototypes.
  528. * bfd_set_section_flags: section prototypes.
  529. * bfd_set_section_size: section prototypes.
  530. * bfd_set_start_address: BFD front end.
  531. * bfd_set_symtab: symbol handling functions.
  532. * bfd_target_list: bfd_target.
  533. * bfd_write_bigendian_4byte_int: Internal.
  534. * bfd_xmalloc: Internal.
  535. * coff_symbol_type: coff.
  536. * core_file_matches_executable_p: Core Files.
  537. * get_symtab_upper_bound: symbol handling functions.
  538. * internal object-file format: Mechanism.
  539. * reloc_chain: typedef arelent.
  540. * stuff: BFD front end.
  541. * the HOWTO macro: typedef arelent.
  542. * what is it?: Overview.
  543.  
  544.  
  545.  
  546.